<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>TurtleDB: ca.uqac.dim.turtledb.NAryRelation Class Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>


</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">TurtleDB
   
   </div>
   <div id="projectbrief">A mini distributed database system</div>
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.6.1 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Packages</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('classca_1_1uqac_1_1dim_1_1turtledb_1_1_n_ary_relation.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a>  </div>
  <div class="headertitle">
<div class="title">ca.uqac.dim.turtledb.NAryRelation Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="ca::uqac::dim::turtledb::NAryRelation" --><!-- doxytag: inherits="ca::uqac::dim::turtledb::Relation" --><div class="dynheader">
Inheritance diagram for ca.uqac.dim.turtledb.NAryRelation:</div>
<div class="dyncontent">
<div class="center"><img src="classca_1_1uqac_1_1dim_1_1turtledb_1_1_n_ary_relation__inherit__graph.png" border="0" usemap="#ca_8uqac_8dim_8turtledb_8_n_ary_relation_inherit__map" alt="Inheritance graph"/></div>
<map name="ca_8uqac_8dim_8turtledb_8_n_ary_relation_inherit__map" id="ca_8uqac_8dim_8turtledb_8_n_ary_relation_inherit__map">
<area shape="rect" id="node3" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_intersection.html" title="ca.uqac.dim.turtledb.Intersection" alt="" coords="518,5,730,32"/><area shape="rect" id="node4" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_product.html" title="ca.uqac.dim.turtledb.Product" alt="" coords="529,56,719,83"/><area shape="rect" id="node5" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_union.html" title="ca.uqac.dim.turtledb.Union" alt="" coords="535,107,713,133"/><area shape="rect" id="node2" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_relation.html" title="ca.uqac.dim.turtledb.Relation" alt="" coords="5,56,197,83"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ca.uqac.dim.turtledb.NAryRelation:</div>
<div class="dyncontent">
<div class="center"><img src="classca_1_1uqac_1_1dim_1_1turtledb_1_1_n_ary_relation__coll__graph.png" border="0" usemap="#ca_8uqac_8dim_8turtledb_8_n_ary_relation_coll__map" alt="Collaboration graph"/></div>
<map name="ca_8uqac_8dim_8turtledb_8_n_ary_relation_coll__map" id="ca_8uqac_8dim_8turtledb_8_n_ary_relation_coll__map">
<area shape="rect" id="node2" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_relation.html" title="ca.uqac.dim.turtledb.Relation" alt="" coords="5,5,197,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_n_ary_relation-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_n_ary_relation_1_1_n_ary_relation_cache_iterator.html">NAryRelationCacheIterator</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_n_ary_relation_1_1_n_ary_relation_stream_iterator.html">NAryRelationStreamIterator</a></td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_schema.html">Schema</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_n_ary_relation.html#a7fa39c21e49765163cdb930d398f0826">getSchema</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_n_ary_relation.html#ac963905a165f53a616f50d18b1635245">addOperand</a> (<a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_relation.html">Relation</a> r)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_n_ary_relation.html#aab8c004f19b9b71dd30ca8313f79f40a">getArity</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_n_ary_relation.html#a33b44f25873ac1eec96e18bed67e50ab">tupleCount</a> ()</td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_n_ary_relation.html#ac57dad1d4c573c5454fd341e55eb0ef8">NAryRelation</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_n_ary_relation.html#ae4fa794c3777a87c88e83955e6bf5371">acceptNAry</a> (<a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_query_visitor.html">QueryVisitor</a> v)  throws VisitorException   </td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">List&lt; <a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_relation.html">Relation</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_n_ary_relation.html#aed20a0eb0271434efde6557d9d1064f9">m_relations</a></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>An <em>n</em>-ary relation is an operator  that accepts a variable number of operands <em>n</em>, with <em>n</em>  2, i.e. <em>R</em><sub>1</sub><em>R</em><sub>2</sub><em>R</em><sub><em>n</em></sub>. Examples of <em>n</em>-ary relations are <a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_union.html">Union</a> and <a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_intersection.html">Intersection</a>. Note that an <em>n</em>-ary relation must be associative (hence the <a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_join.html">Join</a> is not an <em>n</em>-ary relation). </p>
<dl class="author"><dt><b>Author:</b></dt><dd>sylvain </dd></dl>

<p>Definition at line <a class="el" href="_n_ary_relation_8java_source.html#l00034">34</a> of file <a class="el" href="_n_ary_relation_8java_source.html">NAryRelation.java</a>.</p>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ac57dad1d4c573c5454fd341e55eb0ef8"></a><!-- doxytag: member="ca::uqac::dim::turtledb::NAryRelation::NAryRelation" ref="ac57dad1d4c573c5454fd341e55eb0ef8" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_n_ary_relation.html#ac57dad1d4c573c5454fd341e55eb0ef8">ca.uqac.dim.turtledb.NAryRelation.NAryRelation</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="_n_ary_relation_8java_source.html#l00041">41</a> of file <a class="el" href="_n_ary_relation_8java_source.html">NAryRelation.java</a>.</p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ae4fa794c3777a87c88e83955e6bf5371"></a><!-- doxytag: member="ca::uqac::dim::turtledb::NAryRelation::acceptNAry" ref="ae4fa794c3777a87c88e83955e6bf5371" args="(QueryVisitor v)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_n_ary_relation.html#ae4fa794c3777a87c88e83955e6bf5371">ca.uqac.dim.turtledb.NAryRelation.acceptNAry</a> </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_query_visitor.html">QueryVisitor</a>&#160;</td>
          <td class="paramname"><em>v</em></td><td>)</td>
          <td>  throws <a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_query_visitor_1_1_visitor_exception.html">VisitorException</a>   <code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="_n_ary_relation_8java_source.html#l00079">79</a> of file <a class="el" href="_n_ary_relation_8java_source.html">NAryRelation.java</a>.</p>

</div>
</div>
<a class="anchor" id="ac963905a165f53a616f50d18b1635245"></a><!-- doxytag: member="ca::uqac::dim::turtledb::NAryRelation::addOperand" ref="ac963905a165f53a616f50d18b1635245" args="(Relation r)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_n_ary_relation.html#ac963905a165f53a616f50d18b1635245">ca.uqac.dim.turtledb.NAryRelation.addOperand</a> </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_relation.html">Relation</a>&#160;</td>
          <td class="paramname"><em>r</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="_n_ary_relation_8java_source.html#l00056">56</a> of file <a class="el" href="_n_ary_relation_8java_source.html">NAryRelation.java</a>.</p>

</div>
</div>
<a class="anchor" id="aab8c004f19b9b71dd30ca8313f79f40a"></a><!-- doxytag: member="ca::uqac::dim::turtledb::NAryRelation::getArity" ref="aab8c004f19b9b71dd30ca8313f79f40a" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_n_ary_relation.html#aab8c004f19b9b71dd30ca8313f79f40a">ca.uqac.dim.turtledb.NAryRelation.getArity</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns the arity of the operator, i.e. the number of operands. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The arity </dd></dl>

<p>Definition at line <a class="el" href="_n_ary_relation_8java_source.html#l00066">66</a> of file <a class="el" href="_n_ary_relation_8java_source.html">NAryRelation.java</a>.</p>

</div>
</div>
<a class="anchor" id="a7fa39c21e49765163cdb930d398f0826"></a><!-- doxytag: member="ca::uqac::dim::turtledb::NAryRelation::getSchema" ref="a7fa39c21e49765163cdb930d398f0826" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_schema.html">Schema</a> <a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_n_ary_relation.html#a7fa39c21e49765163cdb930d398f0826">ca.uqac.dim.turtledb.NAryRelation.getSchema</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns the relation's schema </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The schema </dd></dl>

<p>Implements <a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_relation.html#a7a7af53642133603e51e04d79f938286">ca.uqac.dim.turtledb.Relation</a>.</p>

<p>Reimplemented in <a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_product.html#a9f04b8b99df3a1c9310740bced83ebb2">ca.uqac.dim.turtledb.Product</a>.</p>

<p>Definition at line <a class="el" href="_n_ary_relation_8java_source.html#l00048">48</a> of file <a class="el" href="_n_ary_relation_8java_source.html">NAryRelation.java</a>.</p>

</div>
</div>
<a class="anchor" id="a33b44f25873ac1eec96e18bed67e50ab"></a><!-- doxytag: member="ca::uqac::dim::turtledb::NAryRelation::tupleCount" ref="a33b44f25873ac1eec96e18bed67e50ab" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_n_ary_relation.html#a33b44f25873ac1eec96e18bed67e50ab">ca.uqac.dim.turtledb.NAryRelation.tupleCount</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns the number of actual tuples present in the query. This number is different from the cardinality of the query; it counts the number of tuples that are present in the leaves of the query tree. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The tuple count </dd></dl>

<p>Implements <a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_relation.html#aa39696dd8f39129e2c02e1323c01b124">ca.uqac.dim.turtledb.Relation</a>.</p>

<p>Definition at line <a class="el" href="_n_ary_relation_8java_source.html#l00071">71</a> of file <a class="el" href="_n_ary_relation_8java_source.html">NAryRelation.java</a>.</p>

</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="aed20a0eb0271434efde6557d9d1064f9"></a><!-- doxytag: member="ca::uqac::dim::turtledb::NAryRelation::m_relations" ref="aed20a0eb0271434efde6557d9d1064f9" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">List&lt;<a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_relation.html">Relation</a>&gt; <a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_n_ary_relation.html#aed20a0eb0271434efde6557d9d1064f9">ca.uqac.dim.turtledb.NAryRelation.m_relations</a><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>The list of relations the operator acts on </p>

<p>Definition at line <a class="el" href="_n_ary_relation_8java_source.html#l00039">39</a> of file <a class="el" href="_n_ary_relation_8java_source.html">NAryRelation.java</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/ca/uqac/dim/turtledb/<a class="el" href="_n_ary_relation_8java_source.html">NAryRelation.java</a></li>
</ul>
</div><!-- contents -->
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="namespaceca.html">ca</a>      </li>
      <li class="navelem"><a class="el" href="namespaceca_1_1uqac.html">uqac</a>      </li>
      <li class="navelem"><a class="el" href="namespaceca_1_1uqac_1_1dim.html">dim</a>      </li>
      <li class="navelem"><a class="el" href="namespaceca_1_1uqac_1_1dim_1_1turtledb.html">turtledb</a>      </li>
      <li class="navelem"><a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_n_ary_relation.html">NAryRelation</a>      </li>

    <li class="footer">Generated on Fri Dec 7 2012 18:55:40 for TurtleDB by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.6.1 </li>
   </ul>
 </div>


</body>
</html>
